<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.app.application</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.app-module.html">Package&nbsp;app</a> ::
        Module&nbsp;application
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.app.application-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module application</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.app.application-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#activate" class="summary-sig-name">activate</a>()</span><br />
      Displays the main ECOTECT window and brings it to the front if it is 
      behind any other windows.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#activate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#alert" class="summary-sig-name">alert</a>(<span class="summary-sig-arg">msg</span>,
        <span class="summary-sig-arg">type</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Displays a popup message box displaying the given message and an OK 
      button.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#alert">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#busy" class="summary-sig-name">busy</a>(<span class="summary-sig-arg">action</span>,
        <span class="summary-sig-arg">message</span>)</span><br />
      Controls the display of the 'Application Busy' dialog box.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#busy">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#center" class="summary-sig-name">center</a>()</span><br />
      Use this command to centre the main Ecotect window withing the 
      current desktop.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#center">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#character" class="summary-sig-name">character</a>(<span class="summary-sig-arg">text</span>)</span><br />
      Use this command to send a stream of characters to the currently 
      focused control.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#character">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#exit" class="summary-sig-name">exit</a>()</span><br />
      This function causes the instance of Ecotect running the script to 
      exit, just as if you had manualy chosen the &gt; Exit menu item.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#exit">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#key" class="summary-sig-name">key</a>(<span class="summary-sig-arg">keyCode</span>)</span><br />
      Use this command to emulate virtual keyboard events in the currently 
      active window or control.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#key">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#maximise" class="summary-sig-name">maximise</a>(<span class="summary-sig-arg">state</span>=<span class="summary-sig-default">1</span>)</span><br />
      Maximises ECOTECT to fill the entire screen.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#maximise">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#menu" class="summary-sig-name">menu</a>(<span class="summary-sig-arg">command</span>,
        <span class="summary-sig-arg">tag</span>=<span class="summary-sig-default">0</span>)</span><br />
      This command is a special method to send interactive commands to the 
ECOTECT application.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#menu">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#minimise" class="summary-sig-name">minimise</a>(<span class="summary-sig-arg">state</span>=<span class="summary-sig-default">1</span>)</span><br />
      Minimises ECOTECT to the task bar.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#minimise">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#mouse_event" class="summary-sig-name">mouse_event</a>(<span class="summary-sig-arg">action</span>,
        <span class="summary-sig-arg">x</span>,
        <span class="summary-sig-arg">y</span>)</span><br />
      This is not a command for the faint hearted and is very experimental 
      at this stage (see below).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#mouse_event">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#progress" class="summary-sig-name">progress</a>(<span class="summary-sig-arg">percent</span>)</span><br />
      Updates the progress indicator displayed in the application status 
      bar.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#progress">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">script</span>)</span><br />
      This command instructs ECOTECT to run the specified script file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#run">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#status" class="summary-sig-name">status</a>(<span class="summary-sig-arg">msg</span>)</span><br />
      This function displays messages in the main application window's 
      status bar.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#status">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_computer" class="summary-sig-name">get_computer</a>()</span><br />
      Returns the system name of the computer the application is currently 
      running on.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_computer">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_image" class="summary-sig-name">get_image</a>(<span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>)</span><br />
      Creates an image of the specified item in the system $TEMP directory 
      and returns the pathname.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_image">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_menu_tool" class="summary-sig-name">get_menu_tool</a>(<span class="summary-sig-arg">index</span>)</span><br />
      Retrieve the user-defined tool data at the specified position within 
      the Tools menu.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_menu_tool">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_menu_tool" class="summary-sig-name">set_menu_tool</a>(<span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">name_path</span>)</span><br />
      Set the user-defined tool data at the specified position within the 
      Tools submenu.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_menu_tool">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_menu_wizard" class="summary-sig-name">get_menu_wizard</a>(<span class="summary-sig-arg">index</span>)</span><br />
      Retrieve the user-defined wizard data at the specified position 
      within the Draw &gt; Geometry Wizards submenu.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_menu_wizard">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_menu_wizard" class="summary-sig-name">set_menu_wizard</a>(<span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">name_path</span>)</span><br />
      Set the user-defined wizard at the specified position within the Draw
      &gt; Geometry Wizards submenu.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_menu_wizard">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_page" class="summary-sig-name">get_page</a>()</span><br />
      Gets the currently active page in the ECOTECT application window.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_page">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_page" class="summary-sig-name">set_page</a>(<span class="summary-sig-arg">page</span>)</span><br />
      Sets the currently active page in the ECOTECT application window.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_page">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_panel" class="summary-sig-name">get_panel</a>()</span><br />
      Gets the currently active panel in the ECOTECT application window.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_panel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_panel" class="summary-sig-name">set_panel</a>(<span class="summary-sig-arg">panel</span>)</span><br />
      Sets the currently active panel in the ECOTECT application window.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_panel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#path" class="summary-sig-name">path</a>()</span><br />
      Getting this property returns a single text string containing the 
      installation home directory of the ECOTECT application which, by 
      default, is usually 'C:\Program Files\Square One'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#path">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_registry" class="summary-sig-name">get_registry</a>(<span class="summary-sig-arg">key</span>)</span><br />
      Use this property to retrieve values from the application's entry 
      within the Windows registry.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_registry">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_registry" class="summary-sig-name">set_registry</a>(<span class="summary-sig-arg">keyvalue</span>)</span><br />
      Use this property to set a value in the application's Windows 
      registry entry.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_registry">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_screen" class="summary-sig-name">get_screen</a>()</span><br />
      Retrieve the position and size of the main Windows screen area.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_screen">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_slider_range" class="summary-sig-name">get_slider_range</a>()</span><br />
      Retrieves the range of the main slider.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_slider_range">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_slider_range" class="summary-sig-name">set_slider_range</a>(<span class="summary-sig-arg">min</span>,
        <span class="summary-sig-arg">max</span>,
        <span class="summary-sig-arg">freq</span>,
        <span class="summary-sig-arg">lineSize</span>,
        <span class="summary-sig-arg">pageSize</span>)</span><br />
      Sets the range of the main slider.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_slider_range">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_slider_scale" class="summary-sig-name">get_slider_scale</a>()</span><br />
      Retrieves the current scale factor for the main slider and the 
      hover-over hint if it is set.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_slider_scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_slider_scale" class="summary-sig-name">set_slider_scale</a>(<span class="summary-sig-arg">scale</span>,
        <span class="summary-sig-arg">hint</span>=<span class="summary-sig-default">None</span>)</span><br />
      Sets the scale factor for the main slider and, optionally, the 
      hover-over hint value.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_slider_scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_slider_title" class="summary-sig-name">get_slider_title</a>()</span><br />
      Retrieves the current title displayed on the main slider.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_slider_title">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_slider_title" class="summary-sig-name">set_slider_title</a>(<span class="summary-sig-arg">title</span>)</span><br />
      Sets the title to be displayed on the main slider.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_slider_title">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_username" class="summary-sig-name">get_username</a>()</span><br />
      Returns the login name of the currently logged in user on the 
      computer running ECOTECT.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_username">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_web_file" class="summary-sig-name">get_web_file</a>(<span class="summary-sig-arg">url</span>)</span><br />
      Retrieve the contents of the specified web URL from the internet and 
      stores it as a temporary file on your local hard disk.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_file">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_web_line" class="summary-sig-name">get_web_line</a>(<span class="summary-sig-arg">lineNumber</span>)</span><br />
      Retrieve individual lines of text from the last call to 
      get.web.page.text.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_line">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_web_login" class="summary-sig-name">set_web_login</a>(<span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>)</span><br />
      Many websites require a login name and password in order to 
      authenticate individual users.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_web_login">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_web_page" class="summary-sig-name">get_web_page</a>(<span class="summary-sig-arg">url</span>,
        <span class="summary-sig-arg">text</span>=<span class="summary-sig-default">False</span>)</span><br />
      Retrieve the contents of the specified web URL from the internet if 
      you have access.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_page">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_web_param" class="summary-sig-name">get_web_param</a>(<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">None</span>)</span><br />
      Many web-based CGI scripts return a series of parameters in the form 
      'key=value'.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_param">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#get_window" class="summary-sig-name">get_window</a>()</span><br />
      Retrieve the position and size of the main ECOTECT window displayed 
      within your screen.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_window">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.app.application-module.html#set_window" class="summary-sig-name">set_window</a>(<span class="summary-sig-arg">left</span>,
        <span class="summary-sig-arg">top</span>,
        <span class="summary-sig-arg">width</span>,
        <span class="summary-sig-arg">height</span>)</span><br />
      Sets the position and size of the main ECOTECT window displayed 
      within your screen.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_window">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="activate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">activate</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#activate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Displays the main ECOTECT window and brings it to the front if it is 
  behind any other windows.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="alert"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">alert</span>(<span class="sig-arg">msg</span>,
        <span class="sig-arg">type</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#alert">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Displays a popup message box displaying the given message and an OK 
  button. You can change the different icons and titles displayed in the 
  dialog using the info, question, warning or error suffixes.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>type If you want an alert dialog, enter &quot;&quot;. Otherwise enter 
  info, question, warning or error</p>
  <p>msg A string containing the message to be displayed.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="busy"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">busy</span>(<span class="sig-arg">action</span>,
        <span class="sig-arg">message</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#busy">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Controls the display of the 'Application Busy' dialog box. Use this 
  dialog during a complex calculation whose progress is not linear or 
  unsuitable for using the standard progress bar.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>action This first parameter gives the required action. The open action
  opens the dialog box and displays the static message provided. The update
  action refreshes the dynamic message line displayed immediately beneath 
  the static message and is used to keep the user informed of progress. The
  close action closes and hides the busy dialog.</p>
  <p>message This parameter provides the message to be displayed within the
  busy dialog. When used with the open action, the message becomes the 
  static title displayed in bold in the centre. When used with the update 
  action, this parameters is used as the dynamic message line displayed 
  immediately beneath the static message. This parameter is ignored when 
  using the close action.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="center"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">center</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#center">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to centre the main Ecotect window withing the current
  desktop. Its size will remain the same, it will simply move into the 
  centre of the screen.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="character"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">character</span>(<span class="sig-arg">text</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#character">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to send a stream of characters to the currently 
  focused control. The text parameter is simply a string of characters. 
  Note: this is very experimental and will need to be used in conjunction 
  with the app.mouseevent or app.keyevent commands to first select the 
  required control.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>text A string of characters that are to be 'typed' or sent to the 
  currently selected control.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="exit"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">exit</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#exit">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This function causes the instance of Ecotect running the script to 
  exit, just as if you had manualy chosen the &gt; Exit menu item. You will
  need to be careful using this command as it may automatically save any 
  changes you have made to the current model unless you use the model.new 
  function first.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="key"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">key</span>(<span class="sig-arg">keyCode</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#key">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to emulate virtual keyboard events in the currently 
  active window or control. With this command you can simulate TAB and 
  control keys. The key parameter is the virtual key code of the key to be 
  pressed, as given in the following table.</p>
  <p>Important Note: Keyboard events are generated directly using the 
  keyboard interrupt, which are then sent to the target application via the
  Windows message queue. Thus, you must give the program time to complete 
  any tasks that may result from each keystroke. If not, the application 
  may miss the next command and hang the script, meaning that you will have
  to disconnect/reconnect.</p>
  <p>To overcome this, use the Script Manager pause(msec) command 
  immediately after such a keystroke or slow down the execution speed of 
  the script using the script(&quot;delay 1000&quot;); command immediately 
  prior to the keystroke.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>keyCode A value specifying the key code to emulate. Some example 
  values are given in the following table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Virtual Key Codes Key Code Value VK_CANCEL 3 VK_PRINT 42 VK_BACK 8 
  VK_EXECUTE 43 VK_TAB 9 VK_SNAPSHOT 44 VK_CLEAR 12 VK_INSERT 45 VK_RETURN 
  13 VK_DELETE 46 VK_SHIFT 16 VK_HELP 47 VK_CONTROL 17 VK_SLEEP 95 VK_MENU 
  18 VK_F1 112 VK_PAUSE 19 VK_F2 113 VK_CAPITAL 20 VK_F3 114 VK_ESCAPE 27 
  VK_F4 115 VK_SPACE 32 VK_F5 116 VK_PRIOR 33 VK_F6 117 VK_NEXT 34 VK_F7 
  118 VK_END 35 VK_F8 119 VK_HOME 36 VK_F9 120 VK_LEFT 37 VK_F10 121 VK_UP 
  38 VK_F11 122 VK_RIGHT 39 VK_F12 123 VK_DOWN 40 VK_NUMLOCK 144 VK_SELECT 
  41 VK_SCROLL 145</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="maximise"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">maximise</span>(<span class="sig-arg">state</span>=<span class="sig-default">1</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#maximise">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Maximises ECOTECT to fill the entire screen. This can be useful if you
  need to give an animated presentation or run a demonstration script.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>state An optional parameter that determines whether the application is
  maximised or restored to its previous state (true to maximise, false to 
  restore). If not given, the command toggles between maximised and normal.
  This is a boolean value where 1 or true represents the affirmative and 0 
  or false the negative.</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>maximise(1)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="menu"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">menu</span>(<span class="sig-arg">command</span>,
        <span class="sig-arg">tag</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#menu">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <pre class="literalblock">


This command is a special method to send interactive commands to the 
ECOTECT application. These are very different from other methods in that 
they allow you to emulate interactive menu commands and actions. This is 
useful for direct command line entry and accessing some functions not 
otherwise available, however you will need to be very careful that you 
do not include commands that invoke dialog boxes or on-screen prompts 
if you intend your script to operate unattended.

Parameter(s)
This command takes the following parameters.

command 
The command parameter can be given as either a value or a token selected 
from the following table. In this case, tokens must be entered in full. 

tag 
The tag parameter defaults to zero if it is not given and is included 
mainly for future extensions.

Relevant Data Table(s)

Available Menu Commands 

File Menu 
    file.new 
    file.new.window 
    file.open 
    file.recentfiles 
    file.revert 
    file.save 
    file.saveas 
    file.import.3d 
    file.import 
    file.export.data 
    file.export.external 
    file.export.image 
    file.export 
    file.print.setup 
    file.print 
    file.projectinfo 
    file.preferences 
    file.exit 
    
Misc File Commands 
    save.results 
    save.grid 
    import.grid 
    export.wrl 
    export.rad 
    export.pov 
    export.dxf 
    export.htb2 
    export.idf 
    export.doe 
    export.sbem 
    export.winair 
    export.fds 
    export.espr 
    export.gbxml
     
Edit Menu 
    edit.undo 
    edit.repeat 
    edit.redo 
    edit.cut 
    edit.copy 
    edit.paste 
    edit.delete 
    edit.duplicate 
    edit.morph 
    edit.facet 
    edit.offset 
    edit.no.linking 
    edit.no.undo 
    edit.link 
    edit.unlink 
    edit.fix 
    edit.ungroup 
    edit.group 
    
View Menu 
    view.undo 
    view.set 
    view.plan 
    view.side 
    view.front 
    view.persp 
    view.axon 
    view.zoom.win 
    view.zoom.obj 
    view.zoom.all 
    view.fit.grid 
    view.drag.grid 
    view.context 
    view.copy.bmp 
    view.copy.emf 
    view.copy 
    view.save 
    view.bitmap.show 
    view.bitmap 
    view.recall 
    view.store 
    view.edit 
Select Menu 
    select.mode 
    select.polar 
    select.measure 
    select.all 
    select.none 
    select.invert 
    select.cells 
    select.adjacent 
    select.previous 
    select.children 
    select.parent 
    select.zone.no 
    select.by.zone 
    select.by.index 
    select.by.material 
    select.by.element 
    select.by.schedule 
    select.by.orientation 
    
Modify Menu 
    modify.moveto.zone 
    modify.moveto.current 
    modify.xform.move 
    modify.xform.rotate 
    modify.xform.scale 
    modify.xform.mirror 
    modify.xform.extrude 
    modify.xform.vectors 
    modify.xform.cap 
    modify.xform.panel 
    modify.origin.global 
    modify.origin.selection 
    modify.origin.centre 
    modify.origin.reset 
    modify.origin.xform 
    modify.assign.shaded 
    modify.assign.reflector 
    modify.assign.acoustic 
    modify.assign.source 
    modify.cut.assign 
    modify.cut.extend 
    modify.cut.trim 
    modify.insert.node 
    modify.edit.nodes 
    modify.delete.node 
    modify.child.extents 
    modify.render.poly 
    modify.reverse 
    modify.normals.unify 
    modify.normals.flip 
    modify.normals.orient 
    modify.create.lights 
    modify.nodes.float 
    modify.nodes.drop 
    modify.surface.grid 
    modify.subdivide.tiles 
    modify.subdivide.points 
    modify.subdivide.line 
    modify.simplify.count 
    modify.simplify.angle 
    modify.merge.triangles 
    modify.merge.polygons 
    modify.align.grid 
    modify.break 
    modify.intersect 
    modify.join 
    
Draw Menu 
    draw.point 
    draw.line 
    draw.plane 
    draw.partion 
    draw.zone 
    draw.insert.child 
    draw.child.window 
    draw.child.void 
    draw.child.panel 
    draw.child.door 
    draw.light 
    draw.speaker 
    draw.appliance 
    draw.camera.objects 
    draw.camera.plan 
    draw.camera.windows 
    draw.camera.from 
    draw.camera.inside 
    draw.camera 
    draw.rect.plane 
    draw.rect.prism 
    draw.rect.zone 
    draw.arc 
    draw.bezier 
    draw.spline 
    draw.roof 
    
Model Menu 
    model.location 
    model.inspector 
    model.zone.manager 
    model.elements 
    model.schedules 
    model.systems 
    model.settings 
    model.moveto.zone 
    model.moveto.current 
    model.make.current 
    model.zone.current 
    model.zone.selected 
    model.zone.all 
    model.zone.hide 
    model.zone.off 
    model.zone.lock 
    
Display Menu 
    display.model 
    display.shadows 
    display.normals 
    display.sketch 
    display &lt;value&gt; 
    display.attr.1 
    display.attr.2 
    display.attr.3 
    display.attr.values 
    display.attr.numbers 
    display.attr.vectors 
    display.attr.colours 
    display.attr.scale 
    display.attr.properties 
    display.attr &lt;value&gt; 
    display.opengl 
    display.vrml 
    display.grid 
    display.rays 
    display.origin 
    display.bitmap 
    display.normal 
    display.detail.low 
    display.detail.partial 
    display.detail.full 
    display.detail.nodes 
    display.shadow.daily 
    display.shadow.annual 
    display.shadow.footprint 
    display.shadow.outlines 
    display.shadow.ground 
    display.shadow.reverse 
    display.shadow.cast 
    display.shadow.receive 
    display.shadow.selected 
    display.shadow.transparent 
    display.shadow.obstructions 
    display.shadow.reflections 
    display.shadow.shadows 
    display.rays.static 
    display.rays.coverage 
    display.rays.incidence 
    display.rays.particles 
    display.rays.rays 
    display.rays.forwards 
    display.rays.backwards 
    display.rays.cycle 
    display.rays.scale 
    display.rays.clear 
    display.grid.extents 
    display.grid.spacing 
    display.grid.autofit 
    display.grid.volumetric 
    display.grid.triangulate 
    display.grid.properties 
    
Calculate Menu 
    calculate.volumes 
    calculate.adjacencies 
    calculate.shading.wizard 
    calculate.shading.extrude 
    calculate.shading.potential 
    calculate.shading.hourly 
    calculate.shading.annual 
    calculate.shading.monthly 
    calculate.shading.profile 
    calculate.shading.range 
    calculate.shading.rays 
    calculate.shading.project 
    calculate.shading.view 
    calculate.stereograph 
    calculate.solar.access 
    calculate.solar.exposure 
    calculate.lighting 
    calculate.rightotlight 
    calculate.photoelectric 
    calculate.autonomy 
    calculate.thermal 
    calculate.comfort 
    calculate.regs.uk 
    calculate.acoustic.rays 
    calculate.acoustic.reverb 
    calculate.acoustic.response 
    calculate.visibility 
    calculate.winds 
    calculate.resources 
    calculate.costs 
    calculate.errors 
    calculate.output 
    calculate.analysis.grid 
    calculate.weather 
    calculate.time 
    
Tools Menu 
    tools.command 
    tools.clearfiles 
    tools.script 
    tools.wizard 
    tools.animation 
    tools.weather 
    tools.world.locations 
    tools.world.map 
    tools.analysis 
    tools.radiance 
    tools.lcaid 
    tools.edit 
    
Help Menu 
    help.topics 
    help.howdoi 
    help.context 
    help.web.support 
    help.teaching.package 
    help.showarrow 
    help.registration 
    help.about 
    
Context Menu 
    context.grid.nodes 
    context.grid.hide 
    context.grid.show 
    context.grid.extents 
    context.grid.spacing 
    context.node.type 
    context.node.smooth 
    context.line.render 
    
Snap Menu 
    snap.none 
    snap.grid 
    snap.align 
    snap.ortho 
    snap.centre 
    snap.point 
    snap.midpt 
    snap.intersect 
    snap.line 
    snap.settings 
    snap &lt;value&gt; 
    
Here is an example:

&gt;&gt;&gt; menu(&quot;file.export.external&quot;)

</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="minimise"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">minimise</span>(<span class="sig-arg">state</span>=<span class="sig-default">1</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#minimise">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Minimises ECOTECT to the task bar. This can be useful if you have a 
  long calculation to perform within a script and want to use the computer 
  for other things while it runs.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>state An optional parameter that determines whether the application is
  minimised or restored to its previous state (true to minimise, false to 
  restore). If not given, the command toggles between minimised and normal.
  This is a boolean value where 1 or true represents the affirmative and 0 
  or false the negative.</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>minimise(1)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="mouse_event"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">mouse_event</span>(<span class="sig-arg">action</span>,
        <span class="sig-arg">x</span>,
        <span class="sig-arg">y</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#mouse_event">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This is not a command for the faint hearted and is very experimental 
  at this stage (see below). It can be used to emulate user mouse actions. 
  The action tokens are given in the table below whereas the x and y values
  give the position in screen pixels where the event is to take place, 
  relative to the top left corner of the main application window. If called
  from methods in the graph, sunpath, opengl or view objects, the pixel 
  values are relative to the top left corner of the graphics canvas in each
  window.</p>
  <p>This command is actually a leftover from early versions of ECOTECT 
  which had a macro record and playback function. This function seemed to 
  work great - on the same machine - however the complexities of system 
  metrics and user preference settings for font and titlebar sizes was soon
  discovered when macros were moved from machine to machine. However, when 
  used with care, this command can be so useful in a show-and-tell 
  demonstration on a known machine that I've left it in. Plus, it is 
  currently the only way of physically invoking context menus.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>action This parameter specifies the type of action/operation to use 
  with the mouse at the given screen location. See the following table for 
  details.</p>
  <p>x Gives the horizontal X location of the desired mouse operation in 
  pixel coordinates relative to the left corner of the application 
  window.</p>
  <p>y Gives the vertical Y location of the desired mouse operation in 
  pixel coordinates relative to the top corner of the application 
  window.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Mouse Actions Token     Description move     move mouse to 
  new position lclick     Left mouse button clicked ldown     Left mouse 
  button pressed lup     Left mouse button released rclick     Right mouse 
  button clicked rdown     Right mouse button pressed rup     Right mouse 
  button released mclick     Middle mouse button clicked mdown     Middle 
  mouse button pressed mup     Middle mouse button released wdown     Mouse
  wheel pressed wup     Mouse wheel released ldblclick     Left mouse 
  button double-clicked rdblclick     Right mouse button double-clicked</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>mouseevent(<span class="py-string">&quot;rclick&quot;</span>, 100, 150)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="progress"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">progress</span>(<span class="sig-arg">percent</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#progress">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Updates the progress indicator displayed in the application status 
  bar.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>percent This parameter gives the progress indicator value is given as 
  either a fraction (0-1) or a percentage (1-100). Any value greater than 1
  is interpreted as a percentage whereas any value between 0 and 1 as a 
  fraction. A value equal to or less than zero (0) hides the status 
  bar.</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>progress(25)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="run"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">script</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#run">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This command instructs ECOTECT to run the specified script file. The 
  current script will pause whilst the new script is run, and will then 
  continue its own execution. If you are running a script from the Script 
  Manager, this command is useful as ECOTECT will run the new script 
  itself, significantly reducing the inter-process communication overhead. 
  You can also use the dofile() LUA command to execute a new script as part
  of an existing one, however this is simply run as an extra command within
  the current script environment.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>script Gives the name of the script to run. If you do not give the 
  full pathname of file, ECOTECT will first search for it in the same 
  directory as the current script, then the current model, then the default
  model directory and then in subfolders within the Square One installation
  directory.</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>run(<span class="py-string">&quot;AcousticRays.scr&quot;</span>)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="status"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">status</span>(<span class="sig-arg">msg</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#status">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This function displays messages in the main application window's 
  status bar. Sometimes you will see two messages in this area; the first 
  specifying what action is taking place and the second in the 
  status/progress area saying 'Please wait...' or similar. To include both 
  messages, simply separate them with the '|' character.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>msg This parameter gives the message to be displayed. If this message 
  contains the '|' character, it will be split with the first shown in the 
  action area and the second in the progress area.</p>
  <p>Here is an example:</p>
<pre class="py-doctest">
<span class="py-prompt">&gt;&gt;&gt; </span>status(<span class="py-string">&quot;Reading zone data|Please wait...&quot;</span>)</pre>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_computer"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_computer</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_computer">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the system name of the computer the application is currently 
  running on.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name A text string containing the computer name.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_image"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_image</span>(<span class="sig-arg">type</span>,
        <span class="sig-arg">name</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_image">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Creates an image of the specified item in the system $TEMP directory 
  and returns the pathname. This command is useful for embedding images in 
  your own HTML reports.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>type Specify the type of image to create. See the following table for 
  available values for this parameter.</p>
  <p>[name] If not given, a pseudo-random unique filename will be used for 
  the image. If you provide a name, then this will be used. Either way, 
  image files are always in JPG format and generated within the system 
  $TEMP directory. This is to ensure that they can be saved and that the 
  resulting directory exists irrespective of which computer the script is 
  run on. You can use the 'Save As' command within your browser to store a 
  complete copy of the resulting page along with it's images.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>imgPath The full path to the image file in the $TEMP directory.</p>
  <p>Relevant Data Table(s)</p>
  <p>Application Image Types Token # Description view 0 The 3D EDITOR Page 
  opengl 1 The VISUALISE Page sunpath 2 The current SunPath diagram graph 3
  The ANALYSIS graph layers 4 The material layer image schedule 5 The 
  current schedule</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_menu_tool"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_menu_tool</span>(<span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_menu_tool">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieve the user-defined tool data at the specified position within 
  the Tools menu. Use this command to check for an empty value before 
  adding a new user tool.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index An integer value between 1 and 9 representing the index of the 
  user tool required.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name The name of the item as it is displayed in the menu itself.</p>
  <p>filepath The full pathname to the associated executable file.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_menu_tool"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_menu_tool</span>(<span class="sig-arg">index</span>,
        <span class="sig-arg">name_path</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_menu_tool">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set the user-defined tool data at the specified position within the 
  Tools submenu. Use this command to add a new tool to the menu or edit an 
  existing item.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index An integer value between 1 and 9 representing the index of the 
  user tool required.</p>
  <p>name|path A text string beginning with the name of the menu item 
  followed by the full pathname of the associated executable file, 
  separated by the '|' character.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_menu_wizard"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_menu_wizard</span>(<span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_menu_wizard">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieve the user-defined wizard data at the specified position within
  the Draw &gt; Geometry Wizards submenu. Use this command to check for an 
  empty value before adding a new user wizard.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index An integer value between 1 and 9 representing the index of the 
  wizard required.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name The name of the item as it is displayed in the menu itself.</p>
  <p>filepath The full pathname to the associated script file.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_menu_wizard"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_menu_wizard</span>(<span class="sig-arg">index</span>,
        <span class="sig-arg">name_path</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_menu_wizard">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Set the user-defined wizard at the specified position within the Draw 
  &gt; Geometry Wizards submenu. Use this command to add a new wizard to 
  the menu or edit an existing one.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index An integer value between 1 and 9 representing the index of the 
  wizard required.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name|path A text string beginning with the name of the menu item 
  followed by the full pathname of the associated script file, separated by
  the '|' character.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_page"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_page</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_page">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the currently active page in the ECOTECT application window. The 
  returned value will correspond to one of the items in the following 
  table.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>page The numerical index of the current application page.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Application Pages ID Description 0 PROJECT Page 1 3D EDITOR 
  Page 2 VISUALISATION Page 3 ANALYSIS Page 4 REPORT Page</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_page"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_page</span>(<span class="sig-arg">page</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_page">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the currently active page in the ECOTECT application window. 
  These correspond to the pages with tabs running down the far left side 
  marked as shown in the following table.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>page The numerical index of the desired application page, as given in 
  the following table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Application Pages ID Description 0 PROJECT Page 1 3D EDITOR 
  Page 2 VISUALISATION Page 3 ANALYSIS Page 4 REPORT Page</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_panel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_panel</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_panel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Gets the currently active panel in the ECOTECT application window. 
  These correspond to the tabbed panels on the right hand side of the 
  window, as shown in the following table. Getting this value returns the 
  integer value corresponding to each item in the table.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>panel The numerical index of the current application panel.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Application Panels ID Description 0 Selection Information 1 
  Zone Management 2 Material Assignments 3 Display Settings 4 Visualisation
  Settings 5 Shadow Settings 6 Analysis Grid 7 Rays and Particles 8 Scripts
  and Wizards 9 Object Transformation 10 Export Manager</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_panel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_panel</span>(<span class="sig-arg">panel</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_panel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the currently active panel in the ECOTECT application window. 
  These correspond to the tabbed panels on the right hand side of the 
  window, as shown in the following table.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>panel Either a string containing the panel token or the numerical 
  index of the desired application panel.</p>
  <p>Relevant Data Table(s)</p>
  <p>Available Application Panels ID Description 0 Selection Information 1 
  Zone Management 2 Material Assignments 3 Display Settings 4 Visualisation
  Settings 5 Shadow Settings 6 Analysis Grid 7 Rays and Particles 8 Scripts
  and Wizards 9 Object Transformation 10 Export Manager</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="path"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">path</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#path">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Getting this property returns a single text string containing the 
  installation home directory of the ECOTECT application which, by default,
  is usually 'C:\Program Files\Square One'. This can be useful if you need 
  to locate example or tutorial files in your script. This property is read
  only.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>path A text string containing the full home directory path.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_registry"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_registry</span>(<span class="sig-arg">key</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_registry">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this property to retrieve values from the application's entry 
  within the Windows registry. Such values are stored on a per-user basic 
  and this property only allows access to values local to this application.
  In ECOTECT, for example, this is located at 
  HKEY_CURRENT_USER\Software\Square One\Ecotect.60. Registry entries are 
  stored as a series of parameters in the form 'key=value'.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>key The name of an existing key stored in the application's registry 
  entry.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A text string containing the value, if any, associated with the 
  given key.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_registry"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_registry</span>(<span class="sig-arg">keyvalue</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_registry">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this property to set a value in the application's Windows registry
  entry. Such values are stored on a per-user basic and this property only 
  allows access to values local to this application. In ECOTECT, for 
  example, this is located at HKEY_CURRENT_USER\Software\Square 
  One\Ecotect.60. Registry entries are stored as a series of parameters in
  the form 'key=value'.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>key=value To set a value, you must include both the key name and the 
  value to be set, separated by an equal '=' character.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_screen"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_screen</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_screen">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieve the position and size of the main Windows screen area.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>left The position of the left side of the screen in pixels.</p>
  <p>top The position of the top side of the screen in pixels.</p>
  <p>width The horizontal width of the screen in pixels.</p>
  <p>height The vertical height of the screen in pixels.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_slider_range"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_slider_range</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_slider_range">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the range of the main slider. The range defines the minimum 
  and maximum values over which the slider moves as well as other settings 
  such as the increment/decrement when using the arrow and PageUp/PageDown 
  keys.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>min The value when the slider is at its minimum.</p>
  <p>max The value when the slider is at its maximum.</p>
  <p>freq The frequency of indicator marks running along the bottom.</p>
  <p>lineSize The increment/decrement value when using the arrow keys.</p>
  <p>pageSize The increment/decrement value when using the PageUp/PageDown 
  keys.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_slider_range"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_slider_range</span>(<span class="sig-arg">min</span>,
        <span class="sig-arg">max</span>,
        <span class="sig-arg">freq</span>,
        <span class="sig-arg">lineSize</span>,
        <span class="sig-arg">pageSize</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_slider_range">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the range of the main slider. The range defines the minimum and 
  maximum values over which the slider moves as well as other settings such
  as the increment/decrement when using the arrow and PageUp/PageDown 
  keys.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>min The value when the slider is at its minimum. This value can be set
  to anything as long as it is less than the 'max' parameter.</p>
  <p>max The value when the slider is at its maximum. This value can be set
  to anything as long as it is greater than the 'min' parameter.</p>
  <p>freq The frequency of indicator marks running along the bottom. If 
  this value is set to zero (0) or less, it is ignored and the currently 
  set value is used.</p>
  <p>lineSize The increment/decrement value when using the arrow keys. If 
  this value is set to zero (0) or less, it is ignored and the currently 
  set value is used.</p>
  <p>pageSize The increment/decrement value when using the PageUp/PageDown 
  keys. If this value is set to zero (0) or less, it is ignored and the 
  currently set value is used.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_slider_scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_slider_scale</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_slider_scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current scale factor for the main slider and the 
  hover-over hint if it is set.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>scale This scale factor is used to convert the range specfied in the 
  app.slider.range setting to a user-readable value (see 
  set.app.slider.scale).</p>
  <p>[hint] This is the popup hint you see when you move the mouse over the
  top of the slider.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_slider_scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_slider_scale</span>(<span class="sig-arg">scale</span>,
        <span class="sig-arg">hint</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_slider_scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the scale factor for the main slider and, optionally, the 
  hover-over hint value.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>scale This scale factor is used to convert the range specfied in the 
  app.slider.range setting to a user-readable value. For example, you may 
  want to display values in percent, but want higher accuracy on the slider
  values. In this case, you can set range.min=0, range.max=1000, 
  range.freq=1 and then the scale to 0.1.</p>
  <p>[hint] By including this optional value, you can set the hover-over 
  hint for the slider when you move the mouse over the top of it.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_slider_title"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_slider_title</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_slider_title">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the current title displayed on the main slider.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>title This is a string value containing the full title.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_slider_title"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_slider_title</span>(<span class="sig-arg">title</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_slider_title">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the title to be displayed on the main slider.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>title This is a string value containing the full title.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_username"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_username</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_username">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the login name of the currently logged in user on the computer
  running ECOTECT.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>name A string value containing the user's login name.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_web_file"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_web_file</span>(<span class="sig-arg">url</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_file">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieve the contents of the specified web URL from the internet and 
  stores it as a temporary file on your local hard disk. You must be 
  responsible for cleaning up these files using the remove() command or 
  manually using the Tools &gt;: Clear Temporary File... menu item.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>url The full Universal Resource Locator (URL) of the web page or CGI 
  script you want to retrieve. If you need to send parameters, use the 
  standard 'url?key1=value1&amp;key2=value2' format.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>tmpfile The full pathname of the temporary file used to store the 
  downloaded contents. The script will return an error if the download 
  failes.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_web_line"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_web_line</span>(<span class="sig-arg">lineNumber</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_line">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieve individual lines of text from the last call to 
  get.web.page.text. There is obviously a limit to the amount of text you 
  can transfer, so it is usually safest to retrieve web text line-by-line. 
  However, if you know the that returned text will be relatively small, you
  can use a line number of -1 to retrieve all the text at once.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>lineNumber The line number to retrieve. You can get the number of 
  lines using get.web.lines, the raw text results will have</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A text string containing the value, if any, associated with the 
  given key.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_web_login"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_web_login</span>(<span class="sig-arg">username</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">password</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_web_login">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Many websites require a login name and password in order to 
  authenticate individual users. Use this property before you request your 
  page to set both of these. You should consider using the getUserInput() 
  function rather than hard-coding passwords within your scripts.</p>
  <p>To clear a previously set username and password, call this property 
  with no parameters.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>[username] The user name you require to login.</p>
  <p>[password] The password you require to login.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_web_page"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_web_page</span>(<span class="sig-arg">url</span>,
        <span class="sig-arg">text</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_page">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieve the contents of the specified web URL from the internet if 
  you have access. As many web-based CGI scripts return a series of 
  parameters in the form 'key=value', by default the downloaded results are
  parsed into a series of parameter pairs and can be accessed using the 
  get.web.param property. If the url you are accessing returns normal text 
  or some other data format, append the suffix '.text' to avoid the parsing
  process and access the data using the get.web.line properties.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>url The full Universal Resource Locator (URL) of the web page or CGI 
  script you want to retrieve. If you need to send parameters, use the 
  standard 'url?key1=value1&amp;key2=value2' format.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>result The number of parameters parsed or, if just text, the number 
  lines downloaded from the web. For success, this value must be at least 
  1.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_web_param"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_web_param</span>(<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">index</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_web_param">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Many web-based CGI scripts return a series of parameters in the form 
  'key=value'. After you have used the get.web.page property, use this to 
  retrieve any value associated with a particular key.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>name The name of the key returned by the web-based CGI script.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A text string containing the value, if any, associated with the 
  given key.</p>
  <p>Many web-based CGI scripts return a series of parameters in the form 
  'key=value'. If you don't know the names of all the keys, you can use the
  index of each one to retrieve them. You can only do this after you have 
  used the get.web.page property and stored the number of parameters 
  parsed.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index The integer index of key=value pair to retrieve.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>key A text string containing the key name.</p>
  <p>value A text string containing the value, if any, associated with that
  key.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_window"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_window</span>()</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#get_window">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieve the position and size of the main ECOTECT window displayed 
  within your screen.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>left The position of the left side of the window in screen pixels.</p>
  <p>top The position of the top side of the window in screen pixels.</p>
  <p>width The horizontal width of the window in screen pixels.</p>
  <p>height The vertical height of the window in screen pixels.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_window"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_window</span>(<span class="sig-arg">left</span>,
        <span class="sig-arg">top</span>,
        <span class="sig-arg">width</span>,
        <span class="sig-arg">height</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.app.application-pysrc.html#set_window">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the position and size of the main ECOTECT window displayed within
  your screen.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>left The position of the left side of the window in screen pixels. If 
  this value is less than zero, the left side of the window will not be 
  changed.</p>
  <p>top The position of the top side of the window in screen pixels. If 
  this value is less than zero, the top of the window will not be 
  changed.</p>
  <p>width The horizontal width of the window in screen pixels. This 
  parameter is optional - if not given or less than zero the width of the 
  window will not be changed.</p>
  <p>height The vertical height of the window in screen pixels. This 
  parameter is optional - if not given or less than zero the height of the 
  window will not be changed.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
